Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add js-docs shortcode to ensure consistency between doc and js code #38316

Merged
merged 6 commits into from Mar 27, 2023

Conversation

hannahiss
Copy link
Contributor

@hannahiss hannahiss commented Mar 24, 2023

Description

  • add js-docs shortcode
  • update documentation to point on snippets.js and sanitizer.js where relevant:
    • alerts.md => pointing on snippets.js
    • modal.md => pointing on snippets.js
    • toats.md => pointing on snippets.js
    • javascript.md => pointing on sanitizer.js

Motivation & Context

Js-docs shortcode will help avoid copy/paste errors and documentation update oversights

Type of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (non-breaking change)
  • Breaking change (fix or feature that would change existing functionality)

Checklist

  • I have read the contributing guidelines
  • My code follows the code style of the project (using npm run lint)
  • My change introduces changes to the documentation
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed

Live previews

Direct links:

Related issues

@hannahiss hannahiss marked this pull request as ready for review March 24, 2023 10:25
@hannahiss hannahiss requested a review from a team as a code owner March 24, 2023 10:25
@XhmikosR XhmikosR added the docs label Mar 24, 2023
@XhmikosR
Copy link
Member

Nice, looking good so far ❤️

@XhmikosR XhmikosR requested a review from mdo March 24, 2023 16:10
Copy link
Member

@mdo mdo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@XhmikosR XhmikosR merged commit 06f7c3b into twbs:main Mar 27, 2023
13 checks passed
@mahilanmjd mahilanmjd mentioned this pull request Apr 16, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Status: No status
Development

Successfully merging this pull request may close these issues.

None yet

3 participants